home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / me_cd25.zip / DOC.ZIP / ME2.DOC < prev    next >
Text File  |  1992-11-09  |  50KB  |  1,084 lines
  1. ========================================================================
  2. ==        ME2 Documentation        Craig Durland  8/88 10/91 ==
  3. ========================================================================
  4.  
  5.   ME2 is a small, portable, extensible [GNU] Emacs' like editor.  This
  6. document describes how individual commands work - it is light on general
  7. usage.  If you need to learn Emacs, look at the GNU, Goslings or
  8. Unipress Emacs manuals.
  9.  
  10.  
  11.              Copyright 1991 Craig Durland
  12.     Distributed under the terms of the GNU General Public License.
  13.   Distributed "as is", without warranties of any kind, but comments,
  14.            suggestions and bug reports are welcome.
  15.  
  16. ========================================================================
  17. ==        Soft keys and Function keys                           ==
  18. ========================================================================
  19.  
  20.   When describing characters or keys, the character itself is used if it
  21. is printable.  Unprintable characters are made printable using 3 or more
  22. printable characters.  For example, the letter "A" is printable but
  23. control-A is not and so the code "C-a" is used to describe it.  The
  24. table below shows the various codes needed to map the unprintable keys.
  25.  
  26. Prefix    Meaning
  27. ------    -------
  28.   C-    Control key.
  29.   F-    Function or soft key such as f1, Home, etc.
  30.   M-    Meta key.  See META in the GLOSSARY.
  31.   S-    Shift.  This only applies to function keys.
  32.  
  33.    This is a list of "extended" keys - those not covered by ASCII.  ME
  34. maps these keys to 3 or more ASCII codes.  Ignore the ME key column
  35. unless you are binding keys.  The keyboard column is the key on the
  36. keyboard you press to generate the ME key which (unless rebound) fires
  37. off the function listed in the Bound to column.
  38.  
  39. Keyboard      ME key    Bound to
  40. --------      -- ---    ----- --
  41.   F1        F-1
  42.   F2        F-2
  43.   F3        F-3
  44.   F4        F-4
  45.   F5        F-5
  46.   F6        F-6
  47.   F7        F-7
  48.   F8        F-8
  49.   F9        F-9
  50.   F10        F-0
  51.   home        F-A    (beginning-of-buffer)
  52.   end        F-B    (end-of-buffer)
  53.   up arrow    F-C    (previous-line)
  54.   down arrow    F-D    (next-line)
  55.   right arrow   F-E    (next-character)
  56.   left arrow    F-F    (previous-character)
  57.   insert    F-G
  58.   delete    F-H    (delete-character)
  59.   page up    F-I    (previous-page)
  60.   page down    F-J    (next-page)
  61.   clear line    F-K    (cut-line)
  62.   delete line    F-L
  63.   insert line    F-M
  64.   select    F-N    (set-mark)
  65.   roll up     F-O    (scroll-down)
  66.   roll down     F-P    (scroll-up)
  67.   DEL        C-?    (delete-character) (This is the DELete key)
  68.   ESC        C-[
  69.   shift tab    M-I
  70.  
  71.   ALT 0..9A..Z!    mapped to META 0..9A..Z!
  72.   Use the ALT key like the control key (ie hold it down while you press the
  73.     next key).
  74.  
  75. For the MS-DOS and OS/2 versions of ME2, the grey keys (on the 101
  76. keyboard) are distinguished from the other keys on the keypad, and the
  77. ordinary keys.
  78.  
  79.   Keyboard         ME key    Bound to
  80.   --------       -- ---    ----- --
  81.   grey-home       S-F-A
  82.   grey-end       S-F-B
  83.   grey-up arrow    S-F-C
  84.   grey-down arrow  S-F-D
  85.   grey-right arrow S-F-E
  86.   grey-left arrow  S-F-F
  87.   grey-insert       S-F-G
  88.   grey-delete       S-F-H
  89.   grey-page up       S-F-I
  90.   grey-page down   S-F-J
  91.   grey--       S-F--
  92.   grey-+       S-F-+
  93.   grey-Enter       S-C-F-M    ;; (Maybe not on the MS-DOS version)
  94.   grey-/       S-F-/
  95.   grey-*       S-F-*
  96.  
  97.  
  98. ========================================================================
  99. ========================================================================
  100.  
  101. Case of letters:
  102.   Meta keys and Control X commands: next letter is ALWAYS uppercase.
  103.   Function keys are case sensitive.
  104.  
  105. ========================================================================
  106. ==            GLOSSARY                      ==
  107. ========================================================================
  108. C-[  See META
  109. args
  110.   Parameters or arguments that will be requested by the command.  If
  111.    [] surround the arg, then it will only be requested in certain cases.
  112.  
  113. binding    See bound.
  114. bound
  115.   A key is attached or bound to a command or program.
  116.   If the key is pressed, whatever it is bound to is invoked.
  117.   Keys can be bound locally or globally.  If a key has a local  binding,
  118.     pressing  the key in the  buffer  it was bound in causes  action.  A
  119.     global  binding  covers all buffers.  Note that local  bindings take
  120.     precedence over global ones.
  121. buffer
  122.   A buffer is an internal workspace where changes are made to text.  If
  123.     a buffer is visible, it is shown through one or more windows.  It is
  124.     usually attached to a file (ie contains the contents of the file).
  125.     If the buffer was created by reading in a file, the buffer name is
  126.     created by removing the path from the file name (and leaving only
  127.     the name and extension).
  128.  
  129. clear
  130.   A operation where something is covered over by something else.  Also
  131.     reset.
  132.   For example:
  133.     If text is cleared, it is covered by blanks.
  134.     If a mark is cleared, it is reset to an initial state (pointing to
  135.       nothing).
  136.   See also:  cut, delete, clear.
  137. command or cmd
  138.   A ME built in command such as (read-file).
  139.   These can be bound to a key to make executing them easier.
  140.   Documented  under  COMMANDS  (in  ME2.DOC).  These are  different  from
  141.     functions  in  that  they  can be  bound  to  keys  or  executed  by
  142.     (ME-command).
  143. Command completion
  144.   ME will  attempt to complete a command if the space bar is pressed and
  145.     completion is on.  The only time you can use command  completion  is
  146.     when you are being queried in the  minibuffer.  For example, when ME
  147.     is requesting a buffer name for  (use-existing-buffer) and foobar is
  148.     a buffer,  typing  "foo" and hitting  space will fill in the rest of
  149.     the name.  ME also trys to fix typos.  If you had typed  "fooie" and
  150.     hit the space bar, you still get "foobar".  Sometimes,  you will hit
  151.     space and only part of the command  name will  appear.  This is ME's
  152.     way of  telling  you there is some  ambiguity  as to the full  name.
  153.     Type some more of the name and hit space  again or press ?  to get a
  154.     list of possible names.
  155.   See also: complete in ME2MUTT.DOC.
  156. cut
  157.   A operation where something is saved and then removed.
  158.   For example:  If text is cut, it is saved in the cut buffer and then
  159.     deleted.  You can retrieve it later from the cut buffer.
  160.   See also:  cut buffer, delete, clear.
  161. Cut buffer
  162.   An invisible buffer that holds things created by deletion commands
  163.     such as (cut-region) and (copy-region).  Used to cut and paste, or
  164.     just cut, text.
  165.   If you want to move a block of text about:  1.  set the mark at one
  166.     end and then move the dot to the other end.  2.  cut the region.  3.
  167.     move the dot to the start of where you want the text to begin and 4.
  168.     yank the cut buffer.  Bingo.
  169.   Copy and cut append to the cut buffer if last command was also a cut
  170.     or copy, otherwise the cut buffer is cleared before the new text is
  171.     entered.
  172.   The cut buffer is also used by (filter).
  173.   Other Emacs' refer to this as the kill buffer.
  174.  
  175. delete
  176.   A operation where something is removed and NOT saved.
  177.   For example:  If text is deleted, it is gone and can't be recovered
  178.     (unless undo can be it back).
  179.   See also:  cut, clear.
  180. dot
  181.   The place between two  characters.  It is  immediately  to the left of
  182.     the cursor.  Also known as point.  One per window or buffer.
  183.  
  184. ESCAPE
  185.   See also META.
  186.   The escape key (usually marked ESC on keyboards) acts like the META key
  187.     for those keyboards that don't have a META key.
  188.  
  189. file
  190.    For MS-DOS, you can use forward slashes "/" as part of the path name.
  191. function or fcn
  192.   The commands that comprise the Mutt programming language.  Documented
  193.     in MUTT2.DOC and ME2MUTT.DOC.  These differ from commands in that
  194.     they cannot be bound to keys and cannot be executed by (ME-command).
  195.  
  196. help
  197.    Help is pretty much limited to reading manuals or asking gurus.
  198.    Limited  forms of online help are  command  completion  (see  above),
  199.      typing a ?  when  being  asked a  question  (see "If you are  being
  200.      asked a question" below), command completion and (describe-bindings).
  201.  
  202. keys
  203.   Keys are used to enter text and invoke commands.  The keys used to